Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented May 26, 2025

Link issues

fixes #6096

Summary By Copilot

Regression?

  • Yes
  • No

Risk

  • High
  • Medium
  • Low

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • Merge the latest code from the main branch

Summary by Sourcery

Add a new MultiSelectFilter component for table column filtering, integrate it into header and cell templates, refine the search input behavior in the existing MultiFilter component, and cover functionality with unit tests.

New Features:

  • Introduce MultiSelectFilter component to support multi-value selection filtering.
  • Integrate MultiSelectFilter into TableColumnFilter for both header rows and inline filters.

Enhancements:

  • Remove redundant input event binding on the MultiFilter search input to simplify change handling.

Tests:

  • Add unit tests for MultiSelectFilter behavior with string and list value types, including filtering, resetting, and condition setting.

@bb-auto bb-auto bot added the enhancement New feature or request label May 26, 2025
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented May 26, 2025

Reviewer's Guide

This PR implements a new multi-select filter component with its rendering and filtering logic, refactors an existing filter input binding, and adds comprehensive unit tests to validate the new component’s behavior.

Sequence Diagram for GetFilterConditions in MultiSelectFilter

sequenceDiagram
    participant C as Caller
    participant MSF as MultiSelectFilter~TType~
    participant FKVA as FilterKeyValueAction

    C->>MSF: GetFilterConditions()
    activate MSF
    MSF->>FKVA: new FilterKeyValueAction() (Logic = Or)
    alt _value1 is string
        MSF->>MSF: items = _value1.Split(',')
        loop for each item in items
            MSF->>FKVA: new FilterKeyValueAction(FieldKey, item, _action1)
            MSF->>FKVA: filter.Filters.Add(subFilter)
        end
    else _value1 is IEnumerable~string~
        loop for each item in _value1 (as values)
            MSF->>FKVA: new FilterKeyValueAction(FieldKey, item, _action1)
            MSF->>FKVA: filter.Filters.Add(subFilter)
        end
    end
    MSF-->>C: filter
    deactivate MSF
Loading

Sequence Diagram: User Applies Filter via MultiSelect

sequenceDiagram
    actor User
    participant MSC as MultiSelect
    participant MSF as MultiSelectFilter
    participant Table as DataTable

    User->>MSC: Selects items
    activate MSC
    MSC->>MSF: Updates _value1 (via @bind-Value)
    MSC->>MSF: OnValueChanged() / Triggers OnFilterAsync()
    activate MSF
    MSF->>MSF: OnFilterAsync()
    MSF->>Table: Applies filter conditions
    Table-->>User: Shows filtered data
    deactivate MSF
    deactivate MSC
Loading

Sequence Diagram: User Changes Filter Action via FilterButton

sequenceDiagram
    actor User
    participant FBC as FilterButton
    participant MSF as MultiSelectFilter
    participant Table as DataTable

    User->>FBC: Selects filter action
    activate FBC
    FBC->>MSF: Updates _action1 (via @bind-Value)
    FBC->>MSF: OnSelectedItemChanged() / Triggers OnFilterAsync()
    activate MSF
    MSF->>MSF: OnFilterAsync()
    MSF->>Table: Applies filter conditions
    Table-->>User: Shows filtered data
    deactivate MSF
    deactivate FBC
Loading

Sequence Diagram: User Clears Filter via FilterButton

sequenceDiagram
    actor User
    participant FBC as FilterButton
    participant MSF as MultiSelectFilter
    participant Table as DataTable

    User->>FBC: Clicks 'Clear Filter'
    activate FBC
    FBC->>MSF: OnClearFilter()
    activate MSF
    MSF->>MSF: Reset() filter state (_value1, _action1, etc.)
    MSF->>Table: Clears filter conditions
    Table-->>User: Shows unfiltered data
    deactivate MSF
    deactivate FBC
Loading

Class Diagram for the new MultiSelectFilter Component

classDiagram
    class FilterBase {
        %% Base class for filter components
    }
    class MultiSelectFilter~TType~ {
        +List~SelectedItem~ Items
        -TType _value1
        -FilterAction _action1
        +Reset() void
        +GetFilterConditions() FilterKeyValueAction
        +SetFilterConditionsAsync(filter: FilterKeyValueAction) Task
    }
    MultiSelectFilter --|> FilterBase
    class FilterKeyValueAction {
      %% Data structure for filter conditions
    }
    class SelectedItem {
      %% Represents an item in a select list
    }
    MultiSelectFilter ..> FilterKeyValueAction : uses
    MultiSelectFilter ..> SelectedItem : uses
Loading

File-Level Changes

Change Details Files
Introduce MultiSelectFilter component with UI and logic
  • Define header and inline rendering templates
  • Implement Reset, GetFilterConditions and SetFilterConditionsAsync supporting strings and lists
  • Expose Items parameter and bind filter value and action
src/BootstrapBlazor/Components/Filters/MultiSelectFilter.razor
src/BootstrapBlazor/Components/Filters/MultiSelectFilter.razor.cs
Refine existing multi-filter search input
  • Remove explicit bind-value:event attribute on search input
  • Rely on default OnValueChanged handling for oninput events
src/BootstrapBlazor/Components/Filters/MultiFilter.razor
Add unit tests for multi-select filter behaviors
  • Verify header row rendering and CSS class toggling
  • Test filter application, reset and setting conditions for string values
  • Test filter behavior with list of strings and mock table/column implementations
test/UnitTest/Components/TableMultiSelectFilterTest.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#6096 Add a MultiSelectFilter component to the BootstrapBlazor library.

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@bb-auto bb-auto bot added this to the v9.6.0 milestone May 26, 2025
@codecov
Copy link

codecov bot commented May 26, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (ac20831) to head (22583d3).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #6097   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          701       703    +2     
  Lines        30968     31026   +58     
  Branches      4380      4387    +7     
=========================================
+ Hits         30968     31026   +58     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

sourcery-ai[bot]
sourcery-ai bot previously approved these changes May 26, 2025
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @ArgoZhang - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 2 issues found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@ArgoZhang ArgoZhang merged commit b331fc3 into main May 26, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the feat-filter branch May 26, 2025 12:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat(MultiSelectFilter): add MultiSelectFilter component

2 participants